3 * Representation of a page version.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Storage\MutableRevisionRecord
;
24 use MediaWiki\Storage\RevisionAccessException
;
25 use MediaWiki\Storage\RevisionRecord
;
26 use MediaWiki\Storage\RevisionStore
;
27 use MediaWiki\Storage\RevisionStoreRecord
;
28 use MediaWiki\Storage\SlotRecord
;
29 use MediaWiki\Storage\SqlBlobStore
;
30 use MediaWiki\User\UserIdentityValue
;
31 use Wikimedia\Rdbms\IDatabase
;
32 use MediaWiki\Linker\LinkTarget
;
33 use MediaWiki\MediaWikiServices
;
34 use Wikimedia\Rdbms\ResultWrapper
;
35 use Wikimedia\Rdbms\FakeResultWrapper
;
38 * @deprecated since 1.31, use RevisionRecord, RevisionStore, and BlobStore instead.
40 class Revision
implements IDBAccessObject
{
42 /** @var RevisionRecord */
45 // Revision deletion constants
46 const DELETED_TEXT
= RevisionRecord
::DELETED_TEXT
;
47 const DELETED_COMMENT
= RevisionRecord
::DELETED_COMMENT
;
48 const DELETED_USER
= RevisionRecord
::DELETED_USER
;
49 const DELETED_RESTRICTED
= RevisionRecord
::DELETED_RESTRICTED
;
50 const SUPPRESSED_USER
= RevisionRecord
::SUPPRESSED_USER
;
51 const SUPPRESSED_ALL
= RevisionRecord
::SUPPRESSED_ALL
;
53 // Audience options for accessors
54 const FOR_PUBLIC
= RevisionRecord
::FOR_PUBLIC
;
55 const FOR_THIS_USER
= RevisionRecord
::FOR_THIS_USER
;
56 const RAW
= RevisionRecord
::RAW
;
58 const TEXT_CACHE_GROUP
= SqlBlobStore
::TEXT_CACHE_GROUP
;
61 * @return RevisionStore
63 protected static function getRevisionStore() {
64 return MediaWikiServices
::getInstance()->getRevisionStore();
68 * @param bool|string $wiki The ID of the target wiki database. Use false for the local wiki.
70 * @return SqlBlobStore
72 protected static function getBlobStore( $wiki = false ) {
73 $store = MediaWikiServices
::getInstance()
74 ->getBlobStoreFactory()
75 ->newSqlBlobStore( $wiki );
77 if ( !$store instanceof SqlBlobStore
) {
78 throw new RuntimeException(
79 'The backwards compatibility code in Revision currently requires the BlobStore '
80 . 'service to be an SqlBlobStore instance, but it is a ' . get_class( $store )
88 * Load a page revision from a given revision ID number.
89 * Returns null if no such revision can be found.
92 * Revision::READ_LATEST : Select the data from the master
93 * Revision::READ_LOCKING : Select & lock the data from the master
96 * @param int $flags (optional)
97 * @return Revision|null
99 public static function newFromId( $id, $flags = 0 ) {
100 $rec = self
::getRevisionStore()->getRevisionById( $id, $flags );
101 return $rec === null ?
null : new Revision( $rec, $flags );
105 * Load either the current, or a specified, revision
106 * that's attached to a given link target. If not attached
107 * to that link target, will return null.
110 * Revision::READ_LATEST : Select the data from the master
111 * Revision::READ_LOCKING : Select & lock the data from the master
113 * @param LinkTarget $linkTarget
114 * @param int $id (optional)
115 * @param int $flags Bitfield (optional)
116 * @return Revision|null
118 public static function newFromTitle( LinkTarget
$linkTarget, $id = 0, $flags = 0 ) {
119 $rec = self
::getRevisionStore()->getRevisionByTitle( $linkTarget, $id, $flags );
120 return $rec === null ?
null : new Revision( $rec, $flags );
124 * Load either the current, or a specified, revision
125 * that's attached to a given page ID.
126 * Returns null if no such revision can be found.
129 * Revision::READ_LATEST : Select the data from the master (since 1.20)
130 * Revision::READ_LOCKING : Select & lock the data from the master
133 * @param int $revId (optional)
134 * @param int $flags Bitfield (optional)
135 * @return Revision|null
137 public static function newFromPageId( $pageId, $revId = 0, $flags = 0 ) {
138 $rec = self
::getRevisionStore()->getRevisionByPageId( $pageId, $revId, $flags );
139 return $rec === null ?
null : new Revision( $rec, $flags );
143 * Make a fake revision object from an archive table row. This is queried
144 * for permissions or even inserted (as in Special:Undelete)
147 * @param array $overrides
149 * @throws MWException
152 public static function newFromArchiveRow( $row, $overrides = [] ) {
154 * MCR Migration: https://phabricator.wikimedia.org/T183564
155 * This method used to overwrite attributes, then passed to Revision::__construct
156 * RevisionStore::newRevisionFromArchiveRow instead overrides row field names
157 * So do a conversion here.
159 if ( array_key_exists( 'page', $overrides ) ) {
160 $overrides['page_id'] = $overrides['page'];
161 unset( $overrides['page'] );
165 * We require a Title for both the Revision object and the RevisionRecord.
166 * Below is duplicated logic from RevisionStore::newRevisionFromArchiveRow
167 * to fetch a title in order pass it into the Revision object.
170 if ( isset( $overrides['title'] ) ) {
171 if ( !( $overrides['title'] instanceof Title
) ) {
172 throw new MWException( 'title field override must contain a Title object.' );
175 $title = $overrides['title'];
177 if ( $title !== null ) {
178 if ( isset( $row->ar_namespace
) && isset( $row->ar_title
) ) {
179 $title = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
181 throw new InvalidArgumentException(
182 'A Title or ar_namespace and ar_title must be given'
187 $rec = self
::getRevisionStore()->newRevisionFromArchiveRow( $row, 0, $title, $overrides );
188 return new Revision( $rec, self
::READ_NORMAL
, $title );
194 * MCR migration note: replaced by RevisionStore::newRevisionFromRow(). Note that
195 * newFromRow() also accepts arrays, while newRevisionFromRow() does not. Instead,
196 * a MutableRevisionRecord should be constructed directly.
197 * RevisionStore::newMutableRevisionFromArray() can be used as a temporary replacement,
198 * but should be avoided.
200 * @param object|array $row
203 public static function newFromRow( $row ) {
204 if ( is_array( $row ) ) {
205 $rec = self
::getRevisionStore()->newMutableRevisionFromArray( $row );
207 $rec = self
::getRevisionStore()->newRevisionFromRow( $row );
210 return new Revision( $rec );
214 * Load a page revision from a given revision ID number.
215 * Returns null if no such revision can be found.
217 * @deprecated since 1.31, use RevisionStore::getRevisionById() instead.
219 * @param IDatabase $db
221 * @return Revision|null
223 public static function loadFromId( $db, $id ) {
224 wfDeprecated( __METHOD__
, '1.31' ); // no known callers
225 $rec = self
::getRevisionStore()->loadRevisionFromId( $db, $id );
226 return $rec === null ?
null : new Revision( $rec );
230 * Load either the current, or a specified, revision
231 * that's attached to a given page. If not attached
232 * to that page, will return null.
234 * @deprecated since 1.31, use RevisionStore::getRevisionByPageId() instead.
236 * @param IDatabase $db
239 * @return Revision|null
241 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
242 $rec = self
::getRevisionStore()->loadRevisionFromPageId( $db, $pageid, $id );
243 return $rec === null ?
null : new Revision( $rec );
247 * Load either the current, or a specified, revision
248 * that's attached to a given page. If not attached
249 * to that page, will return null.
251 * @deprecated since 1.31, use RevisionStore::getRevisionByTitle() instead.
253 * @param IDatabase $db
254 * @param Title $title
256 * @return Revision|null
258 public static function loadFromTitle( $db, $title, $id = 0 ) {
259 $rec = self
::getRevisionStore()->loadRevisionFromTitle( $db, $title, $id );
260 return $rec === null ?
null : new Revision( $rec );
264 * Load the revision for the given title with the given timestamp.
265 * WARNING: Timestamps may in some circumstances not be unique,
266 * so this isn't the best key to use.
268 * @deprecated since 1.31, use RevisionStore::getRevisionByTimestamp()
269 * or RevisionStore::loadRevisionFromTimestamp() instead.
271 * @param IDatabase $db
272 * @param Title $title
273 * @param string $timestamp
274 * @return Revision|null
276 public static function loadFromTimestamp( $db, $title, $timestamp ) {
277 $rec = self
::getRevisionStore()->loadRevisionFromTimestamp( $db, $title, $timestamp );
278 return $rec === null ?
null : new Revision( $rec );
282 * Return a wrapper for a series of database rows to
283 * fetch all of a given page's revisions in turn.
284 * Each row can be fed to the constructor to get objects.
286 * @param LinkTarget $title
287 * @return ResultWrapper
288 * @deprecated Since 1.28, no callers in core nor in known extensions. No-op since 1.31.
290 public static function fetchRevision( LinkTarget
$title ) {
291 wfDeprecated( __METHOD__
, '1.31' );
292 return new FakeResultWrapper( [] );
296 * Return the value of a select() JOIN conds array for the user table.
297 * This will get user table rows for logged-in users.
299 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.
302 public static function userJoinCond() {
303 wfDeprecated( __METHOD__
, '1.31' );
304 return [ 'LEFT JOIN', [ 'rev_user != 0', 'user_id = rev_user' ] ];
308 * Return the value of a select() page conds array for the page table.
309 * This will assure that the revision(s) are not orphaned from live pages.
311 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.
314 public static function pageJoinCond() {
315 wfDeprecated( __METHOD__
, '1.31' );
316 return [ 'INNER JOIN', [ 'page_id = rev_page' ] ];
320 * Return the list of revision fields that should be selected to create
322 * @deprecated since 1.31, use RevisionStore::getQueryInfo() instead.
325 public static function selectFields() {
326 global $wgContentHandlerUseDB;
328 wfDeprecated( __METHOD__
, '1.31' );
344 $fields +
= CommentStore
::newKey( 'rev_comment' )->getFields();
346 if ( $wgContentHandlerUseDB ) {
347 $fields[] = 'rev_content_format';
348 $fields[] = 'rev_content_model';
355 * Return the list of revision fields that should be selected to create
356 * a new revision from an archive row.
357 * @deprecated since 1.31, use RevisionStore::getArchiveQueryInfo() instead.
360 public static function selectArchiveFields() {
361 global $wgContentHandlerUseDB;
363 wfDeprecated( __METHOD__
, '1.31' );
381 $fields +
= CommentStore
::newKey( 'ar_comment' )->getFields();
383 if ( $wgContentHandlerUseDB ) {
384 $fields[] = 'ar_content_format';
385 $fields[] = 'ar_content_model';
391 * Return the list of text fields that should be selected to read the
393 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'text' ] ) instead.
396 public static function selectTextFields() {
397 wfDeprecated( __METHOD__
, '1.31' );
405 * Return the list of page fields that should be selected from page table
406 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.
409 public static function selectPageFields() {
410 wfDeprecated( __METHOD__
, '1.31' );
422 * Return the list of user fields that should be selected from user table
423 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.
426 public static function selectUserFields() {
427 wfDeprecated( __METHOD__
, '1.31' );
428 return [ 'user_name' ];
432 * Return the tables, fields, and join conditions to be selected to create
433 * a new revision object.
435 * @deprecated since 1.31, use RevisionStore::getQueryInfo() instead.
436 * @param array $options Any combination of the following strings
437 * - 'page': Join with the page table, and select fields to identify the page
438 * - 'user': Join with the user table, and select the user name
439 * - 'text': Join with the text table, and select fields to load page text
440 * @return array With three keys:
441 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
442 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
443 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
445 public static function getQueryInfo( $options = [] ) {
446 return self
::getRevisionStore()->getQueryInfo( $options );
450 * Return the tables, fields, and join conditions to be selected to create
451 * a new archived revision object.
453 * @deprecated since 1.31, use RevisionStore::getArchiveQueryInfo() instead.
454 * @return array With three keys:
455 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
456 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
457 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
459 public static function getArchiveQueryInfo() {
460 return self
::getRevisionStore()->getArchiveQueryInfo();
464 * Do a batched query to get the parent revision lengths
466 * @deprecated in 1.31, use RevisionStore::getRevisionSizes instead.
468 * @param IDatabase $db
469 * @param array $revIds
472 public static function getParentLengths( $db, array $revIds ) {
473 return self
::getRevisionStore()->listRevisionSizes( $db, $revIds );
477 * @param object|array|RevisionRecord $row Either a database row or an array
478 * @param int $queryFlags
479 * @param Title|null $title
483 function __construct( $row, $queryFlags = 0, Title
$title = null ) {
486 if ( $row instanceof RevisionRecord
) {
487 $this->mRecord
= $row;
488 } elseif ( is_array( $row ) ) {
489 // If no user is specified, fall back to using the global user object, to stay
490 // compatible with pre-1.31 behavior.
491 if ( !isset( $row['user'] ) && !isset( $row['user_text'] ) ) {
492 $row['user'] = $wgUser;
495 $this->mRecord
= self
::getRevisionStore()->newMutableRevisionFromArray(
498 $this->ensureTitle( $row, $queryFlags, $title )
500 } elseif ( is_object( $row ) ) {
501 $this->mRecord
= self
::getRevisionStore()->newRevisionFromRow(
504 $this->ensureTitle( $row, $queryFlags, $title )
507 throw new InvalidArgumentException(
508 '$row must be a row object, an associative array, or a RevisionRecord'
514 * Make sure we have *some* Title object for use by the constructor.
515 * For B/C, the constructor shouldn't fail even for a bad page ID or bad revision ID.
517 * @param array|object $row
518 * @param int $queryFlags
519 * @param Title|null $title
521 * @return Title $title if not null, or a Title constructed from information in $row.
523 private function ensureTitle( $row, $queryFlags, $title = null ) {
528 if ( is_array( $row ) ) {
529 if ( isset( $row['title'] ) ) {
530 if ( !( $row['title'] instanceof Title
) ) {
531 throw new MWException( 'title field must contain a Title object.' );
534 return $row['title'];
537 $pageId = isset( $row['page'] ) ?
$row['page'] : 0;
538 $revId = isset( $row['id'] ) ?
$row['id'] : 0;
540 $pageId = isset( $row->rev_page
) ?
$row->rev_page
: 0;
541 $revId = isset( $row->rev_id
) ?
$row->rev_id
: 0;
545 $title = self
::getRevisionStore()->getTitle( $pageId, $revId, $queryFlags );
546 } catch ( RevisionAccessException
$ex ) {
547 // construct a dummy title!
548 wfLogWarning( __METHOD__
. ': ' . $ex->getMessage() );
550 // NOTE: this Title will only be used inside RevisionRecord
551 $title = Title
::makeTitleSafe( NS_SPECIAL
, "Badtitle/ID=$pageId" );
552 $title->resetArticleID( $pageId );
559 * @return RevisionRecord
561 public function getRevisionRecord() {
562 return $this->mRecord
;
570 public function getId() {
571 return $this->mRecord
->getId();
575 * Set the revision ID
577 * This should only be used for proposed revisions that turn out to be null edits.
579 * @note Only supported on Revisions that were constructed based on associative arrays,
580 * since they are mutable.
583 * @param int|string $id
584 * @throws MWException
586 public function setId( $id ) {
587 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
588 $this->mRecord
->setId( intval( $id ) );
590 throw new MWException( __METHOD__
. ' is not supported on this instance' );
595 * Set the user ID/name
597 * This should only be used for proposed revisions that turn out to be null edits
599 * @note Only supported on Revisions that were constructed based on associative arrays,
600 * since they are mutable.
603 * @deprecated since 1.31, please reuse old Revision object
604 * @param int $id User ID
605 * @param string $name User name
606 * @throws MWException
608 public function setUserIdAndName( $id, $name ) {
609 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
610 $user = new UserIdentityValue( intval( $id ), $name );
611 $this->mRecord
->setUser( $user );
613 throw new MWException( __METHOD__
. ' is not supported on this instance' );
620 private function getMainSlotRaw() {
621 return $this->mRecord
->getSlot( 'main', RevisionRecord
::RAW
);
625 * Get the ID of the row of the text table that contains the content of the
626 * revision's main slot, if that content is stored in the text table.
628 * If the content is stored elsewhere, this returns null.
630 * @deprecated since 1.31, use RevisionRecord()->getSlot()->getContentAddress() to
631 * get that actual address that can be used with BlobStore::getBlob(); or use
632 * RevisionRecord::hasSameContent() to check if two revisions have the same content.
636 public function getTextId() {
637 $slot = $this->getMainSlotRaw();
638 return $slot->hasAddress()
639 ? self
::getBlobStore()->getTextIdFromAddress( $slot->getAddress() )
644 * Get parent revision ID (the original previous page revision)
646 * @return int|null The ID of the parent revision. 0 indicates that there is no
647 * parent revision. Null indicates that the parent revision is not known.
649 public function getParentId() {
650 return $this->mRecord
->getParentId();
654 * Returns the length of the text in this revision, or null if unknown.
658 public function getSize() {
660 return $this->mRecord
->getSize();
661 } catch ( RevisionAccessException
$ex ) {
667 * Returns the base36 sha1 of the content in this revision, or null if unknown.
669 * @return string|null
671 public function getSha1() {
673 return $this->mRecord
->getSha1();
674 } catch ( RevisionAccessException
$ex ) {
680 * Returns the title of the page associated with this entry.
681 * Since 1.31, this will never return null.
683 * Will do a query, when title is not set and id is given.
687 public function getTitle() {
688 $linkTarget = $this->mRecord
->getPageAsLinkTarget();
689 return Title
::newFromLinkTarget( $linkTarget );
693 * Set the title of the revision
695 * @deprecated: since 1.31, this is now a noop. Pass the Title to the constructor instead.
697 * @param Title $title
699 public function setTitle( $title ) {
700 if ( !$title->equals( $this->getTitle() ) ) {
701 throw new InvalidArgumentException(
702 $title->getPrefixedText()
703 . ' is not the same as '
704 . $this->mRecord
->getPageAsLinkTarget()->__toString()
714 public function getPage() {
715 return $this->mRecord
->getPageId();
719 * Fetch revision's user id if it's available to the specified audience.
720 * If the specified audience does not have access to it, zero will be
723 * @param int $audience One of:
724 * Revision::FOR_PUBLIC to be displayed to all users
725 * Revision::FOR_THIS_USER to be displayed to the given user
726 * Revision::RAW get the ID regardless of permissions
727 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
728 * to the $audience parameter
731 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
734 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
738 $user = $this->mRecord
->getUser( $audience, $user );
739 return $user ?
$user->getId() : 0;
743 * Fetch revision's user id without regard for the current user's permissions
746 * @deprecated since 1.25, use getUser( Revision::RAW )
748 public function getRawUser() {
749 wfDeprecated( __METHOD__
, '1.25' );
750 return $this->getUser( self
::RAW
);
754 * Fetch revision's username if it's available to the specified audience.
755 * If the specified audience does not have access to the username, an
756 * empty string will be returned.
758 * @param int $audience One of:
759 * Revision::FOR_PUBLIC to be displayed to all users
760 * Revision::FOR_THIS_USER to be displayed to the given user
761 * Revision::RAW get the text regardless of permissions
762 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
763 * to the $audience parameter
766 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
769 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
773 $user = $this->mRecord
->getUser( $audience, $user );
774 return $user ?
$user->getName() : '';
778 * Fetch revision's username without regard for view restrictions
781 * @deprecated since 1.25, use getUserText( Revision::RAW )
783 public function getRawUserText() {
784 wfDeprecated( __METHOD__
, '1.25' );
785 return $this->getUserText( self
::RAW
);
789 * Fetch revision comment if it's available to the specified audience.
790 * If the specified audience does not have access to the comment, an
791 * empty string will be returned.
793 * @param int $audience One of:
794 * Revision::FOR_PUBLIC to be displayed to all users
795 * Revision::FOR_THIS_USER to be displayed to the given user
796 * Revision::RAW get the text regardless of permissions
797 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
798 * to the $audience parameter
801 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
804 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
808 $comment = $this->mRecord
->getComment( $audience, $user );
809 return $comment === null ?
null : $comment->text
;
813 * Fetch revision comment without regard for the current user's permissions
816 * @deprecated since 1.25, use getComment( Revision::RAW )
818 public function getRawComment() {
819 wfDeprecated( __METHOD__
, '1.25' );
820 return $this->getComment( self
::RAW
);
826 public function isMinor() {
827 return $this->mRecord
->isMinor();
831 * @return int Rcid of the unpatrolled row, zero if there isn't one
833 public function isUnpatrolled() {
834 return self
::getRevisionStore()->getRcIdIfUnpatrolled( $this->mRecord
);
838 * Get the RC object belonging to the current revision, if there's one
840 * @param int $flags (optional) $flags include:
841 * Revision::READ_LATEST : Select the data from the master
844 * @return RecentChange|null
846 public function getRecentChange( $flags = 0 ) {
847 return self
::getRevisionStore()->getRecentChange( $this->mRecord
, $flags );
851 * @param int $field One of DELETED_* bitfield constants
855 public function isDeleted( $field ) {
856 return $this->mRecord
->isDeleted( $field );
860 * Get the deletion bitfield of the revision
864 public function getVisibility() {
865 return $this->mRecord
->getVisibility();
869 * Fetch revision content if it's available to the specified audience.
870 * If the specified audience does not have the ability to view this
871 * revision, or the content could not be loaded, null will be returned.
873 * @param int $audience One of:
874 * Revision::FOR_PUBLIC to be displayed to all users
875 * Revision::FOR_THIS_USER to be displayed to $user
876 * Revision::RAW get the text regardless of permissions
877 * @param User $user User object to check for, only if FOR_THIS_USER is passed
878 * to the $audience parameter
880 * @return Content|null
882 public function getContent( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
885 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
890 return $this->mRecord
->getContent( 'main', $audience, $user );
892 catch ( RevisionAccessException
$e ) {
898 * Get original serialized data (without checking view restrictions)
901 * @deprecated since 1.31, use BlobStore::getBlob instead.
905 public function getSerializedData() {
906 $slot = $this->getMainSlotRaw();
907 return $slot->getContent()->serialize();
911 * Returns the content model for the main slot of this revision.
913 * If no content model was stored in the database, the default content model for the title is
914 * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
915 * is used as a last resort.
917 * @todo: drop this, with MCR, there no longer is a single model associated with a revision.
919 * @return string The content model id associated with this revision,
920 * see the CONTENT_MODEL_XXX constants.
922 public function getContentModel() {
923 return $this->getMainSlotRaw()->getModel();
927 * Returns the content format for the main slot of this revision.
929 * If no content format was stored in the database, the default format for this
930 * revision's content model is returned.
932 * @todo: drop this, the format is irrelevant to the revision!
934 * @return string The content format id associated with this revision,
935 * see the CONTENT_FORMAT_XXX constants.
937 public function getContentFormat() {
938 $format = $this->getMainSlotRaw()->getFormat();
940 if ( $format === null ) {
941 // if no format was stored along with the blob, fall back to default format
942 $format = $this->getContentHandler()->getDefaultFormat();
949 * Returns the content handler appropriate for this revision's content model.
951 * @throws MWException
952 * @return ContentHandler
954 public function getContentHandler() {
955 return ContentHandler
::getForModelID( $this->getContentModel() );
961 public function getTimestamp() {
962 return $this->mRecord
->getTimestamp();
968 public function isCurrent() {
969 return ( $this->mRecord
instanceof RevisionStoreRecord
) && $this->mRecord
->isCurrent();
973 * Get previous revision for this title
975 * @return Revision|null
977 public function getPrevious() {
978 $title = $this->getTitle();
979 $rec = self
::getRevisionStore()->getPreviousRevision( $this->mRecord
, $title );
980 return $rec === null ?
null : new Revision( $rec, self
::READ_NORMAL
, $title );
984 * Get next revision for this title
986 * @return Revision|null
988 public function getNext() {
989 $title = $this->getTitle();
990 $rec = self
::getRevisionStore()->getNextRevision( $this->mRecord
, $title );
991 return $rec === null ?
null : new Revision( $rec, self
::READ_NORMAL
, $title );
995 * Get revision text associated with an old or archive row
997 * Both the flags and the text field must be included. Including the old_id
998 * field will activate cache usage as long as the $wiki parameter is not set.
1000 * @param stdClass $row The text data
1001 * @param string $prefix Table prefix (default 'old_')
1002 * @param string|bool $wiki The name of the wiki to load the revision text from
1003 * (same as the the wiki $row was loaded from) or false to indicate the local
1004 * wiki (this is the default). Otherwise, it must be a symbolic wiki database
1005 * identifier as understood by the LoadBalancer class.
1006 * @return string|false Text the text requested or false on failure
1008 public static function getRevisionText( $row, $prefix = 'old_', $wiki = false ) {
1009 $textField = $prefix . 'text';
1010 $flagsField = $prefix . 'flags';
1012 if ( isset( $row->$flagsField ) ) {
1013 $flags = explode( ',', $row->$flagsField );
1018 if ( isset( $row->$textField ) ) {
1019 $text = $row->$textField;
1024 $cacheKey = isset( $row->old_id
) ?
( 'tt:' . $row->old_id
) : null;
1026 return self
::getBlobStore( $wiki )->expandBlob( $text, $flags, $cacheKey );
1030 * If $wgCompressRevisions is enabled, we will compress data.
1031 * The input string is modified in place.
1032 * Return value is the flags field: contains 'gzip' if the
1033 * data is compressed, and 'utf-8' if we're saving in UTF-8
1036 * @param mixed &$text Reference to a text
1039 public static function compressRevisionText( &$text ) {
1040 return self
::getBlobStore()->compressData( $text );
1044 * Re-converts revision text according to it's flags.
1046 * @param mixed $text Reference to a text
1047 * @param array $flags Compression flags
1048 * @return string|bool Decompressed text, or false on failure
1050 public static function decompressRevisionText( $text, $flags ) {
1051 return self
::getBlobStore()->decompressData( $text, $flags );
1055 * Insert a new revision into the database, returning the new revision ID
1056 * number on success and dies horribly on failure.
1058 * @param IDatabase $dbw (master connection)
1059 * @throws MWException
1060 * @return int The revision ID
1062 public function insertOn( $dbw ) {
1065 // Note that $this->mRecord->getId() will typically return null here, but not always,
1066 // e.g. not when restoring a revision.
1068 if ( $this->mRecord
->getUser( RevisionRecord
::RAW
) === null ) {
1069 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
1070 $this->mRecord
->setUser( $wgUser );
1072 throw new MWException( 'Cannot insert revision with no associated user.' );
1076 $rec = self
::getRevisionStore()->insertRevisionOn( $this->mRecord
, $dbw );
1078 $this->mRecord
= $rec;
1080 // Avoid PHP 7.1 warning of passing $this by reference
1082 // TODO: hard-deprecate in 1.32 (or even 1.31?)
1083 Hooks
::run( 'RevisionInsertComplete', [ &$revision, null, null ] );
1085 return $rec->getId();
1089 * Get the base 36 SHA-1 value for a string of text
1090 * @param string $text
1093 public static function base36Sha1( $text ) {
1094 return SlotRecord
::base36Sha1( $text );
1098 * Create a new null-revision for insertion into a page's
1099 * history. This will not re-save the text, but simply refer
1100 * to the text from the previous version.
1102 * Such revisions can for instance identify page rename
1103 * operations and other such meta-modifications.
1105 * @param IDatabase $dbw
1106 * @param int $pageId ID number of the page to read from
1107 * @param string $summary Revision's summary
1108 * @param bool $minor Whether the revision should be considered as minor
1109 * @param User|null $user User object to use or null for $wgUser
1110 * @return Revision|null Revision or null on error
1112 public static function newNullRevision( $dbw, $pageId, $summary, $minor, $user = null ) {
1118 $comment = CommentStoreComment
::newUnsavedComment( $summary, null );
1120 $title = Title
::newFromID( $pageId, Title
::GAID_FOR_UPDATE
);
1121 if ( $title === null ) {
1125 $rec = self
::getRevisionStore()->newNullRevision( $dbw, $title, $comment, $minor, $user );
1127 return new Revision( $rec );
1131 * Determine if the current user is allowed to view a particular
1132 * field of this revision, if it's marked as deleted.
1134 * @param int $field One of self::DELETED_TEXT,
1135 * self::DELETED_COMMENT,
1136 * self::DELETED_USER
1137 * @param User|null $user User object to check, or null to use $wgUser
1140 public function userCan( $field, User
$user = null ) {
1141 return self
::userCanBitfield( $this->getVisibility(), $field, $user );
1145 * Determine if the current user is allowed to view a particular
1146 * field of this revision, if it's marked as deleted. This is used
1147 * by various classes to avoid duplication.
1149 * @param int $bitfield Current field
1150 * @param int $field One of self::DELETED_TEXT = File::DELETED_FILE,
1151 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1152 * self::DELETED_USER = File::DELETED_USER
1153 * @param User|null $user User object to check, or null to use $wgUser
1154 * @param Title|null $title A Title object to check for per-page restrictions on,
1155 * instead of just plain userrights
1158 public static function userCanBitfield( $bitfield, $field, User
$user = null,
1167 return RevisionRecord
::userCanBitfield( $bitfield, $field, $user, $title );
1171 * Get rev_timestamp from rev_id, without loading the rest of the row
1173 * @param Title $title
1176 * @return string|bool False if not found
1178 static function getTimestampFromId( $title, $id, $flags = 0 ) {
1179 return self
::getRevisionStore()->getTimestampFromId( $title, $id, $flags );
1183 * Get count of revisions per page...not very efficient
1185 * @param IDatabase $db
1186 * @param int $id Page id
1189 static function countByPageId( $db, $id ) {
1190 return self
::getRevisionStore()->countRevisionsByPageId( $db, $id );
1194 * Get count of revisions per page...not very efficient
1196 * @param IDatabase $db
1197 * @param Title $title
1200 static function countByTitle( $db, $title ) {
1201 return self
::getRevisionStore()->countRevisionsByTitle( $db, $title );
1205 * Check if no edits were made by other users since
1206 * the time a user started editing the page. Limit to
1207 * 50 revisions for the sake of performance.
1210 * @deprecated since 1.24
1212 * @param IDatabase|int $db The Database to perform the check on. May be given as a
1213 * Database object or a database identifier usable with wfGetDB.
1214 * @param int $pageId The ID of the page in question
1215 * @param int $userId The ID of the user in question
1216 * @param string $since Look at edits since this time
1218 * @return bool True if the given user was the only one to edit since the given timestamp
1220 public static function userWasLastToEdit( $db, $pageId, $userId, $since ) {
1221 if ( is_int( $db ) ) {
1222 $db = wfGetDB( $db );
1225 return self
::getRevisionStore()->userWasLastToEdit( $db, $pageId, $userId, $since );
1229 * Load a revision based on a known page ID and current revision ID from the DB
1231 * This method allows for the use of caching, though accessing anything that normally
1232 * requires permission checks (aside from the text) will trigger a small DB lookup.
1233 * The title will also be loaded if $pageIdOrTitle is an integer ID.
1235 * @param IDatabase $db ignored!
1236 * @param int|Title $pageIdOrTitle Page ID or Title object
1237 * @param int $revId Known current revision of this page. Determined automatically if not given.
1238 * @return Revision|bool Returns false if missing
1241 public static function newKnownCurrent( IDatabase
$db, $pageIdOrTitle, $revId = 0 ) {
1242 $title = $pageIdOrTitle instanceof Title
1244 : Title
::newFromID( $pageIdOrTitle );
1250 $record = self
::getRevisionStore()->getKnownCurrentRevision( $title, $revId );
1251 return $record ?
new Revision( $record ) : false;